<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: contrib/sIPOPT/src/SensUtils.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.12</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('SensUtils_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">SensUtils.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="SensUtils_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// Copyright 2009, 2011 Hans Pirnay</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// Date   : 2009-05-14</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#ifndef __SENSCUTILS_HPP__</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#define __SENSCUTILS_HPP__</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IpUtils_8hpp.html">IpUtils.hpp</a>&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IpAlgTypes_8hpp.html">IpAlgTypes.hpp</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IpReturnCodes_8hpp.html">IpReturnCodes.hpp</a>&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;{</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">/* This header file provides some definitions used throughout the program. */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126">   21</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126">SensAlgorithmExitStatus</a></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;{</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126a293096ffc6a0550b6ab9f134ca79d013">   23</a></span>&#160;   <a class="code" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126a293096ffc6a0550b6ab9f134ca79d013">SOLVE_SUCCESS</a>,</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;   <a class="code" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126aa9c8e97080fc5d2d8f01348bb5b3aa89">FATAL_ERROR</a></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126aa9c8e97080fc5d2d8f01348bb5b3aa89">   25</a></span>&#160;};</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#aa39945f96a04d19ea6f24ffb67abe7e2">   27</a></span>&#160;SIPOPTLIB_EXPORT <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> <a class="code" href="namespaceIpopt.html#aa39945f96a04d19ea6f24ffb67abe7e2">AsIndexMax</a>(</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;   <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>        length,</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;   <span class="keyword">const</span> <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>* x,</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;   <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>        Incr</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;);</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#a77ff4dbca9aa5d63b6ede7e77c56c16c">   33</a></span>&#160;SIPOPTLIB_EXPORT <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> <a class="code" href="namespaceIpopt.html#a77ff4dbca9aa5d63b6ede7e77c56c16c">AsIndexSum</a>(</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;   <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>        length,</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;   <span class="keyword">const</span> <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>* x,</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;   <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>        Incr</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;);</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#a334ce463bb33929ee1ff24ce080241a8">   39</a></span>&#160;SIPOPTLIB_EXPORT <span class="keywordtype">void</span> <a class="code" href="namespaceIpopt.html#a334ce463bb33929ee1ff24ce080241a8">append_Index</a>(</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;   std::string&amp; str,</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;   <a class="code" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>        idx</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;);</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#a92aaa8a8bbd6d35edb476bdb569b9d22">   44</a></span>&#160;SIPOPTLIB_EXPORT <a class="code" href="namespaceIpopt.html#a53a5dc5f64f568252ba7bb7385e7f834">SolverReturn</a> <a class="code" href="namespaceIpopt.html#a92aaa8a8bbd6d35edb476bdb569b9d22">AppReturn2SolverReturn</a>(</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;   <a class="code" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">ApplicationReturnStatus</a> ipopt_retval</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;);</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;}</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">// same as DECLARE_STD_EXCEPTION, but using SIPOPTLIB_EXPORT instead of IPOPTLIB_EXPORT</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="preprocessor">#define DECLARE_STD_SIPOPT_EXCEPTION(__except_type) \</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="SensUtils_8hpp.html#ad63949cc73e4271b72a6d80e0625ff88">   51</a></span>&#160;<span class="preprocessor">    class SIPOPTLIB_EXPORT  __except_type : public Ipopt::IpoptException \</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor">    { \</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">    public: \</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">      __except_type(const std::string&amp; msg, const std::string&amp; fname, Ipopt::Index line) \</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">      : Ipopt::IpoptException(msg,fname,line, #__except_type) {} \</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">      __except_type(const __except_type&amp; copy) \</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">      : Ipopt::IpoptException(copy) {} \</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">    private: \</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">       __except_type(); \</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">       void operator=(const __except_type&amp;); \</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">    }</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aIpUtils_8hpp_html"><div class="ttname"><a href="IpUtils_8hpp.html">IpUtils.hpp</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_add98abac06d6862395ef27d827938126aa9c8e97080fc5d2d8f01348bb5b3aa89"><div class="ttname"><a href="namespaceIpopt.html#add98abac06d6862395ef27d827938126aa9c8e97080fc5d2d8f01348bb5b3aa89">Ipopt::FATAL_ERROR</a></div><div class="ttdeci">@ FATAL_ERROR</div><div class="ttdef"><b>Definition:</b> <a href="SensUtils_8hpp_source.html#l00025">SensUtils.hpp:24</a></div></div>
<div class="ttc" id="aIpAlgTypes_8hpp_html"><div class="ttname"><a href="IpAlgTypes_8hpp.html">IpAlgTypes.hpp</a></div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition:</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
<div class="ttc" id="aIpReturnCodes_8hpp_html"><div class="ttname"><a href="IpReturnCodes_8hpp.html">IpReturnCodes.hpp</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_aa39945f96a04d19ea6f24ffb67abe7e2"><div class="ttname"><a href="namespaceIpopt.html#aa39945f96a04d19ea6f24ffb67abe7e2">Ipopt::AsIndexMax</a></div><div class="ttdeci">SIPOPTLIB_EXPORT Index AsIndexMax(Index length, const Index *x, Index Incr)</div></div>
<div class="ttc" id="anamespaceIpopt_html_a334ce463bb33929ee1ff24ce080241a8"><div class="ttname"><a href="namespaceIpopt.html#a334ce463bb33929ee1ff24ce080241a8">Ipopt::append_Index</a></div><div class="ttdeci">SIPOPTLIB_EXPORT void append_Index(std::string &amp;str, Index idx)</div></div>
<div class="ttc" id="aIpReturnCodes__inc_8h_html_ab542e0b1ca364a9b7525a876ffdae7d7"><div class="ttname"><a href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">ApplicationReturnStatus</a></div><div class="ttdeci">ApplicationReturnStatus</div><div class="ttdoc">Return codes for the Optimize call for an application.</div><div class="ttdef"><b>Definition:</b> <a href="IpReturnCodes__inc_8h_source.html#l00013">IpReturnCodes_inc.h:14</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_a5a4a27f325033a0e5d85a4ebc4038b57"><div class="ttname"><a href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Ipopt::Index</a></div><div class="ttdeci">ipindex Index</div><div class="ttdoc">Type of all indices of vectors, matrices etc.</div><div class="ttdef"><b>Definition:</b> <a href="IpTypes_8hpp_source.html#l00020">IpTypes.hpp:20</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_add98abac06d6862395ef27d827938126a293096ffc6a0550b6ab9f134ca79d013"><div class="ttname"><a href="namespaceIpopt.html#add98abac06d6862395ef27d827938126a293096ffc6a0550b6ab9f134ca79d013">Ipopt::SOLVE_SUCCESS</a></div><div class="ttdeci">@ SOLVE_SUCCESS</div><div class="ttdef"><b>Definition:</b> <a href="SensUtils_8hpp_source.html#l00023">SensUtils.hpp:23</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_a92aaa8a8bbd6d35edb476bdb569b9d22"><div class="ttname"><a href="namespaceIpopt.html#a92aaa8a8bbd6d35edb476bdb569b9d22">Ipopt::AppReturn2SolverReturn</a></div><div class="ttdeci">SIPOPTLIB_EXPORT SolverReturn AppReturn2SolverReturn(ApplicationReturnStatus ipopt_retval)</div></div>
<div class="ttc" id="anamespaceIpopt_html_a53a5dc5f64f568252ba7bb7385e7f834"><div class="ttname"><a href="namespaceIpopt.html#a53a5dc5f64f568252ba7bb7385e7f834">Ipopt::SolverReturn</a></div><div class="ttdeci">SolverReturn</div><div class="ttdoc">enum for the return from the optimize algorithm</div><div class="ttdef"><b>Definition:</b> <a href="IpAlgTypes_8hpp_source.html#l00019">IpAlgTypes.hpp:20</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_add98abac06d6862395ef27d827938126"><div class="ttname"><a href="namespaceIpopt.html#add98abac06d6862395ef27d827938126">Ipopt::SensAlgorithmExitStatus</a></div><div class="ttdeci">SensAlgorithmExitStatus</div><div class="ttdef"><b>Definition:</b> <a href="SensUtils_8hpp_source.html#l00021">SensUtils.hpp:22</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_a77ff4dbca9aa5d63b6ede7e77c56c16c"><div class="ttname"><a href="namespaceIpopt.html#a77ff4dbca9aa5d63b6ede7e77c56c16c">Ipopt::AsIndexSum</a></div><div class="ttdeci">SIPOPTLIB_EXPORT Index AsIndexSum(Index length, const Index *x, Index Incr)</div></div>
</body>
</html>
